home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / TODAY028.ZIP / ONTODAY.DOC < prev    next >
Encoding:
Text File  |  1996-03-07  |  22.3 KB  |  497 lines
  1.  
  2.       ┌─
  3.       │  ┌──────┐┌─────┐     ┌───────┐┌──────┐┌─────┐ ┌──────┐┌─┐   ┌─┐
  4.       │  └──────┘└─────┘     └───────┘└──────┘└─────┘ └──────┘└─┘   └─┘
  5.       │  ┌─┐  ┌─┐┌─┐  ┌─┐       ┌─┐   ┌─┐  ┌─┐┌─┐  ┌─┐┌──────┐┌───────┐
  6.       │  │ │  │ ││ │  │ │       │ │   │ │  │ ││ │  │ ││ ┌──┐ │└──┐ ┌──┘
  7.       │  │ └──┘ ││ │  │ │       │ │   │ └──┘ ││ └──┘ ││ │  │ │   │ │
  8.       │  └──────┘└─┘  └─┘       └─┘   └──────┘└──────┘└─┘  └─┘   └─┘
  9.       └─────────────────────────────────────────────────────────── v0.28 ─
  10.  
  11.                          A 'Who Called Today' Generator
  12.                      (c) Copyright 1994-1996, Dwayne Heaton
  13.  
  14.              ┌─
  15.              │                       Index
  16.              └───────────────────────────────────────────────────
  17.  
  18.                                   Introduction
  19.              
  20.              What is OnToday ? .............................. 1.1
  21.              System Hardware & software requirements ........ 1.2
  22.              Disclaimer and Licensing agreement ............. 1.3
  23.  
  24.              Installation ................................... 2.0
  25.  
  26.                                      Usage
  27.  
  28.              Command Line ................................... 3.1
  29.              The ONTODAY.CTL file ........................... 3.2
  30.              Mailer Support ................................. 3.3
  31.  
  32.              Bug Reports and Contacting the Author .......... 4.0
  33.  
  34.              Credits and Thanks ............................. 5.0
  35.  
  36.  
  37.  
  38. ┌─
  39. │  1.1  ■  What is OnToday ?
  40. └─────────────────────────────────────────────────────────────────────────────
  41.  
  42.   OnToday is a 'Todays Callers' ASCII / ANSi / AVATAR bulletin generator with
  43.   a difference.
  44.  
  45.   It also allows you to export your last BBS caller into your mailer's history
  46.   and produce ASCII / ANSi / AVATAR bulletins of Inbound and/or Outbound mail
  47.   calls.
  48.  
  49.   It also allows you to export information about fax calls you have received
  50.   into your mailer's history.
  51.  
  52.   OnToday was written to generate a bulletin of callers to my BBS, allowing
  53.   users to see who has already called the system that day. My BBS software
  54.   (RemoteAccess) already had a facility to do this, but I wanted a different
  55.   layout of the information, and to make new callers stand out from all the
  56.   other users.
  57.  
  58.   This was the humble beginnings of OnToday..
  59.  
  60.   Since the first version, I've had many request for additional features.
  61.   These included an export last BBS caller to mailer option, and also an
  62.   export last FAX call to mailer option. So support for FrontDoor and
  63.   InterMail frontend mailers was included, and support for BGFAX was also
  64.   added, including the option to generate bulletins of Today's Inbound and
  65.   Outbound Mail, and todays inbound FAX calls.
  66.  
  67.   OnToday is written to generate it's bulletins as quickly as possible with
  68.   the minimum of configuring and fiddling by the user.
  69.  
  70.   And Finally, the program is NOT crippled in any way whatsoever, and
  71.   DOESN'T require any registration fees at all :-)
  72.  
  73.  
  74. ┌─
  75. │  1.2  ■  System hardware and software requirements
  76. └─────────────────────────────────────────────────────────────────────────────
  77.  
  78.   ■  An IBM PC, XT, AT or 100% compatible PC with a hard disk.
  79.   ■  Microsoft MS-DOS, IBM PC-DOS or DR-DOS version 3.30 or later. Version
  80.      5.0 or later is recommended.
  81.   ■  At least 128KB of RAM available.
  82.  
  83.   ■  At the moment OnToday only supports the following BBSes:
  84.        ■ Remote Access    Copyright (c) Wantree Development & Andrew Milner
  85.  
  86.   ■  OnToday has been successfully tested with Remote Access v2.00, v2.01,
  87.      v2.02 and v2.50g1
  88.  
  89.   ■  At the moment OnToday only supports the following Mailers:
  90.        ■ FrontDoor        Copyright (c) Joaquim H. Homrighausen
  91.        ■ InterMail        Copyright (c) InterZone Software, Inc
  92.  
  93.   ■  OnToday has been successfully tested with FrontDoor v2.02, v2.11,
  94.      v2.12, v2.20c.ml and InterMail v2.29c, v2.29f.
  95.  
  96.   ■  At the moment OnToday only supports the following Fax Programs:
  97.        ■ BGFAX            Copyright (c) B.J. Guillot
  98.  
  99.   ■  OnToday has been successfully tested with BGFAX v1.47, v1.50.
  100.  
  101.   ■  OnToday has been successfully tested with MS-DOS 5.0, 6.0, 6.2 and
  102.      6.22, 4DOS 5.0 and 5.5, IBM OS/2 WARP, Novell Netware Lite v1.1,
  103.      Novell Netware v3.12 on systems equiped with Intel/AMD 8086, 80286,
  104.      80386, 80486 and Pentium processors.
  105.  
  106.   ■  OS/2 is a registered trademark of IBM Corporation
  107.      MS-DOS is a registered trademark of Microsoft Corporation
  108.  
  109.      All other programs are copyright and/or trademarked by their
  110.      respective author unless otherwise noted.
  111.  
  112.  
  113. ┌─
  114. │  1.3  ■  Disclaimer and Licensing Agreement
  115. └─────────────────────────────────────────────────────────────────────────────
  116.  
  117.     ONTODAY consists of all files contained within the distribution archive.
  118.     Before running ONTODAY, you must read and agree to the following
  119.     conditions. If you do not or can not agree to and accept the following
  120.     conditions, you are prohibited from using ONTODAY.
  121.  
  122.  ■  The documentation and accompanying program are copyrighted material 
  123.     designed, produced and tested by the author of the software.
  124.  
  125.  ■  ONTODAY is distributed as FREEWARE *NOT* Public Domain!
  126.  
  127.  ■  Since this product is FREEWARE, you are actively encouraged to copy and
  128.     distribute it as long as it remains in its complete form with all support
  129.     and documentation files. No files may be added or taken away from the
  130.     original archived form in which ONTODAY is distributed.
  131.  
  132.  ■  Shareware vendors and BBSes may redistribute this product as long as they
  133.     do not charge any money or monies for the product. Cost of distribution
  134.     media (be it disk, CD-ROM, tape, etc) and/or subscription charges are
  135.     acceptable.
  136.  
  137.  ■  I (Dwayne Heaton) am NOT oligated to provide new versions or support for
  138.     ONTODAY.
  139.  
  140.  ■  In the event that future versions of ONTODAY are released, Dwayne Heaton
  141.     reserves the right not to release them under the FREEWARE concept and to
  142.     charge a nominal fee should it be deemed appropriate.
  143.  
  144.  ■  Although every care and attention has been taken to write and test the
  145.     program to make sure that it does what this documentation states, the
  146.     program is provided as it is, without warranty or guarantee of any kind,
  147.     either expressed or implied, as to the quality or performance of this
  148.     program, except that it will occupy disk space.
  149.  
  150.  ■  The author shall not be held liable to you or anyone else for any direct,
  151.     indirect, incidental or consequential damages, including any lost profits,
  152.     lost savings, lost business, which may result from the use or inability 
  153.     to use this program.
  154.  
  155.  ■  You are NOT allowed to do any disassembling, reverse engineering, creating
  156.     patches for ONTODAY and things alike.
  157.  
  158.  ■  Your use of this program constitutes your agreement to this disclaimer and
  159.     your release of the author from any form of liability or litigation.
  160.  
  161.  ■  The source code or part of it, is NOT available.
  162.  
  163.  ■  All rights reserved worldwide.
  164.  
  165.  
  166. ┌─
  167. │  2.0  ■  Installation
  168. └─────────────────────────────────────────────────────────────────────────────
  169.  
  170.   Making use of OnToday couldn't be much easier!  Unpack all the files
  171.   in the archive into one directory.
  172.  
  173.   A new feature of OnToday (as from v0.22) is the ability to configure the
  174.   program to suit your system. An example config file can be created by
  175.   running the SETUP.EXE program. It will be created with default settings.
  176.  
  177.   The config file ('ONTODAY.CTL') must be in the same directory that you are
  178.   running OnToday from. It doesn't have to exist, but if you want greater
  179.   control over the program, it should (since it gives you more options than
  180.   the command line). The control (config) file is explained in more detail
  181.   in section 3.2, 'The ONTODAY.CTL file'
  182.  
  183.   You will need to have the RA environment variable set, so that it points
  184.   to your Remote Access system directory, but if you are running RA without
  185.   any problems, this should be already be set  :)
  186.  
  187.   If you wish to make use of the BGFAX import to mailer facilities you MUST
  188.   have the BGFAX environment variable set (pointing to the BGFAX directory)
  189.   and if you are running in a multi-line system (FD 2.20.ml & IM Multi-line)
  190.   you must have the TASK set to the node number (ie set TASK=2)
  191.  
  192.   Once you have installed OnToday, you are ready to produce your bulletins.
  193.   The bulletins will be placed in the main Text Files directory as specified
  194.   in your Remote Access configuration file.
  195.  
  196.   You could run it after every call to the BBS, or you could run it in any
  197.   daily maintenance events.
  198.  
  199.  
  200.   NOTE - OnToday will try and use SHARE to open all files it needs. This
  201.          will allow multi-line BBS's to run it without having any problems
  202.          with sharing violations.
  203.  
  204.  
  205. ┌─
  206. │  3.1  ■  Command Line
  207. └─────────────────────────────────────────────────────────────────────────────
  208.  
  209.   There are a few command-line options you can use for greater control over
  210.   the program's operation. When used in conjunction with the control file
  211.   these options over-ride any settings in the file.
  212.  
  213.   If you do not specify any options OnToday will use its internal defaults
  214.   of ignoring HIDDEN users, generating ASCII, ANSi and AVATAR screens,
  215.   excluding the Sysop, using the users real name and automatically detecting
  216.   if you have a colour display, so that it can use the appropriate display
  217.   scheme for its screen.
  218.  
  219.  
  220.   ONTODAY -?              Shows a brief help screen with all options listed
  221.                           on it.
  222.  
  223.           -HELP           Same as above.
  224.  
  225.           -SYSOP          This will force OnToday to include the Sysop in
  226.                           the bulletin. The Sysop will still be excluded if
  227.                           they are a 'hidden' user, and the '-HIDDEN' option
  228.                           is not specified.
  229.  
  230.           -HANDLES        This will make OnToday use the handles for users
  231.                           instead of using their real names.
  232.  
  233.           -HIDDEN         This will tell OnToday to include any user that
  234.                           has been set as 'hidden'
  235.                           (A hidden user is one that has the 'exclude from
  236.                            user list' flag set)
  237.  
  238.           -NOASCII        Stops OnToday producing the ASCII bulletins
  239.  
  240.           -NOANSI         Stops OnToday producing the ANSi bulletins
  241.  
  242.           -NOAVATAR       Stops OnToday producing the AVATAR bulletins
  243.  
  244.  
  245. ┌─
  246. │  3.2  ■  The ONTODAY.CTL file
  247. └─────────────────────────────────────────────────────────────────────────────
  248.  
  249.   As said before the control (config) file will allow you to fully configure
  250.   OnToday to your system. It will allow you to set all the options that the
  251.   command line does, but has several more options.
  252.  
  253.   To create an initial ONTODAY.CTL file or update your existing file to
  254.   this versions options run SETUP.EXE and follow any on-screen instructions
  255.  
  256.   As of Ontoday v0.28, there is a new version of the setup program. It is
  257.   now fully menu driven, and all options are configurable using it. 
  258.  
  259.   The options can be in any order, and any line starting with a ';' is
  260.   counted as a comment line and isn't processed.
  261.  
  262.   Here is a list of options you can use, and a description or what they do.
  263.   
  264.    SystemAddress            This is the address of your system, this is
  265.                             used when importing your last RA caller into
  266.                             your mailer lastcaller. When producing inbound
  267.                             /outbound mail bulletins, any call from this
  268.                             number is ignored.
  269.    Mailer                   This is the mailer you are using. At the moment
  270.                             it only accepts FD202, FD21x, FD220, IM and None.
  271.    RA_To_Mailer_Import      Whether to import your last RA caller into your
  272.                             mailer last caller.
  273.    Fax_To_Mailer_Import     Whether you want your FAX calls imported into
  274.                             your mailer last caller & history log.
  275.    MultiLine                Whether you are running a multiline system.
  276.                             This refers to RemoteAccess. This will add the
  277.                             node (Line) number of the callers in the 'Todays
  278.                             Callers' list.
  279.    IncludeSysop             Whether to include the Sysop in the output, or
  280.                             not. (Even if he/she is also a hidden user)
  281.    IncludeHidden            Include users marked as hidden in the output.
  282.    UseHandles               Use user-handles instead of their real names.
  283.    ASCII                    Whether to produce ASCII output files.
  284.    ANSi                     Whether to produce ANSi output files.
  285.    AVATAR                   Whether to produce AVATAR output files.
  286.    EnterPrompt              Whether to include an enter prompt at the end of
  287.                             each bulletin.
  288.    MaskLocal                Whether to use 'LocalBaud' to mask local
  289.                             logons. If set to no OnToday will use 'LOCAL'
  290.                             as the baud.
  291.    LocalBaud                The masked baud rate to use for local callers.
  292.  
  293.    Main.Title               The colour 'Todays Callers to ..' is displayed.
  294.    Main.TitleUnderLine      The colour of the line under the above option.
  295.    Main.Header              The colour of the headings line ('Username...')
  296.    Main.HeaderUnderLine     The colour of the line under the above option.
  297.  
  298.    Caller.Node              The colour of the node the caller logged in on.
  299.                             (This is only used if MultiLine is used)
  300.    Caller.Name              What colour you want the users name/handle to be.
  301.    Caller.Location          This sets the colour the users location is
  302.                             displayed in.
  303.    Caller.TimesCalled       The times the user has called colour
  304.    Caller.BaudRate          The users baud rate, the colour.
  305.    Caller.LogOn             The colour of the Time the user logged on.
  306.    Caller.LogOff            The colour of the Time the user logged off.
  307.  
  308.    Mail.TimeCalled          The colour of the Time the mail call started
  309.    Mail.SystemName          The colour the System Name will be displayed in.
  310.    Mail.ReceivedBytes       The colour of the bytes recieved (In/Outbound)
  311.    Mail.SentBytes           The colour of the bytes sent (In/Outbound)
  312.    Mail.NodeAddress         The colour the systems node number.
  313.  
  314.    Fax.SystemName           The colour of the Fax System's name
  315.    Fax.PageCount            The colour of the number of pages received
  316.    Fax.ReceivedBytes        The colour of the number of bytes received
  317.    Fax.Start                The colour of the Time the fax started
  318.    Fax.Finish               The colour of the Time the fax stopped
  319.    Fax.BaudRate             The colour of the fax connect speed.
  320.  
  321.    ASC_OnToday              The filename of the ASCII Todays Callers bulletin.
  322.    ANS_OnToday              The filename of the ANSi Todays Callers bulletin.
  323.    AVT_OnToday              The filename of the AVATAR Todays Callers bulletin.
  324.    ASC_InBound              The filename of the ASCII Inbound Mail bulletin.
  325.    ANS_InBound              The filename of the ANSi Inbound Mail bulletin.
  326.    AVT_InBound              The filename of the AVATAR Inbound Mail bulletin.
  327.    ASC_OutBound             The filename of the ASCII Outbound Mail bulletin.
  328.    ANS_OutBound             The filename of the ANSi Outbound Mail bulletin.
  329.    AVT_OutBound             The filename of the AVATAR Outbound Mail bulletin.
  330.    ASC_FaxIn                The filename of the ASCII Fax Calls bulletin.
  331.    ANS_FaxIn                The filename of the ANSi Fax Calls bulletin.
  332.    AVT_FaxIn                The filename of the AVATAR Fax Calls bulletin.
  333.  
  334.  
  335.   SystemAddress must be a valid 4D mail address. ie 2:252/314.0
  336.  
  337.   Mailer accepts the following values : FD202, FD21x, FD220, IM, None
  338.  
  339.   RA_To_Mailer_Import, Fax_To_Mailer, MultiLine, IncludeSysop, IncludeHidden,
  340.   UseHandles, ASCII, ANSi, EnterPrompt and MaskLocal accept the following
  341.   values : Yes or No, On or Off, True or False
  342.  
  343.   MailerNodes, LocalBaud must be an integer, from 1 to 99999.
  344.  
  345.   A??_Callers, A??_Inbound, A??_Outbound, A??_FaxIn reconize the following
  346.   values: No, Off, False.  Any thing other these is interpreted as a filename..
  347.  
  348.   TitleColour, TitleUnderLineColour, HeadingColour, HeadingUnderLineColour,
  349.   NodeColour, NameColour, LocationColour, CalledColour, BaudColour,
  350.   LogOnColour, LogOffColour, MailSystemColour, MailRcvdColour, MailSentColour
  351.   and MailNodeColour accept valid colour names or numbers.
  352.  
  353.    ╓─────────────── Table of valid colour names and numbers ─────────────────╖
  354.    ╠════╤══════════╗╔════╤══════════════╗╔════╤════════════╗╔════╤═══════════╣
  355.    ║  0 │ Black    ║║  1 │ Blue         ║║  2 │ Green      ║║  3 │ Cyan      ║
  356.    ║  4 │ Red      ║║  5 │ Magenta      ║║  6 │ Brown      ║║  7 │ LightGray ║
  357.    ║  8 │ DarkGray ║║  9 │ LightBlue    ║║ 10 │ LightGreen ║║ 11 │ LightCyan ║
  358.    ║ 12 │ LightRed ║║ 13 │ LightMagenta ║║ 14 │ Yellow     ║║ 15 │ White     ║
  359.    ╠════╧══════════╝╚════╧══════════════╝╚════╧════════════╝╚════╧═══════════╣
  360.    ╙─────────────────────────────────────────────────────────────────────────╜
  361.  
  362.  
  363. ┌─
  364. │  3.3  ■  Mailer Support
  365. └─────────────────────────────────────────────────────────────────────────────
  366.  
  367.   If you wish to use OnToday's mailer routines, you must have the appropriate
  368.   control file options enabled, and you must have the environment variable
  369.   for your mailer setup. IM for InterMail and FD for FrontDoor.
  370.  
  371.   OnToday will allow you to export the last BBS caller (The last BBS caller
  372.   that is listed in the bulletin. ie If the last caller was a user with the
  373.   hidden flag set and you do not include hidden users, OnToday will ignore
  374.   that user, and try and import the last user it didn't ignore into the
  375.   mailer's history file)
  376.  
  377.   As of v0.26, On Today is fully multi-line aware. It will (with the correct
  378.   option in the control file) display the line number of the user in the
  379.   'Todays Callers' bulletin, and will import the caller into the correct
  380.   mailer history file and last inbound/outbound caller files. This should
  381.   only be used on FrontDoor 2.20ml and multi-line InterMail systems.
  382.   
  383.   The imported BBS user has the username, baud rate and their location (It
  384.   also adds  [NEW]  for new users)
  385.  
  386.   example:
  387.  
  388.   Dwayne Heaton [28800] [NEW]
  389.   Virtual Maddness BBS
  390.  
  391.  
  392.   The Inbound/Outbound Mail bulletins
  393.   -----------------------------------
  394.   
  395.   These display various bits of information about calls to/from your system
  396.   and can be turned off if you so require. 
  397.  
  398.   It includes the Time of the call, the name of the system that was called,
  399.   how many bytes of data were sent and received and the node number of the
  400.   system.
  401.  
  402.   This was added because some sysops wanted a bulletin to show their users
  403.   why the system was busy, even though there was no users on at the same
  404.   time.
  405.  
  406.   If you are running FrontDoor 2.20 or InterMail multi-line this bulletin
  407.   will have a page of calls to/from your system for EACH line. 
  408.  
  409.  
  410. ┌─
  411. │  4.0  ■  Bug Reports and Contacting the Author
  412. └─────────────────────────────────────────────────────────────────────────────
  413.  
  414.   Please contact me if you have any bug reports and/or suggestions for
  415.   improvements to OnToday.
  416.  
  417.   If you have a bug report, just mail me a filled in REPORT.BUG (this file
  418.   should have been included in the distribution archive) at one of the
  419.   addresses below.
  420.  
  421.   I'm open to suggestions for support for other BBS or mailer software. If
  422.   you wish this please supply the structure of the userbase (and all
  423.   related files) files (PASCAL is prefered, but I can work with C) of the
  424.   BBS software you wish supported (Also, could you give me a list of
  425.   environment variables it uses, and filenames)
  426.  
  427.   ie. RA points to the RemoteAccess directory.
  428.          RemoteAccess's configuration file is called 'CONFIG.RA'
  429.       FD points to the Front Door directory.
  430.          Front Door's configuration file is called 'SETUP.FD'
  431.       IM points to the InterMail directory.
  432.          InterMail's configuration file is called 'FD.SYS'
  433.  
  434.   I cannot guarantee it will be supported in future versions (if any),
  435.   but you never know.
  436.  
  437.   I can be contacted using a number of different methods:
  438.  
  439.   Page/Leave a message on my BBS:
  440.    Virtual Maddness -- +44-1344-422575 -- 24 hours, 300 to 28800 baud
  441.  
  442.   Send a netmail to me at one of my various AKAs:
  443.    FidoNet    :  2:252/314.0
  444.    RANet      :  73:7441/13.0
  445.    PascalNet  :  115:4401/407.0
  446.    InterNet   :  dwayne.heaton@vmadd.demon.co.uk
  447.                  dwayne@roan.co.uk
  448.  
  449.  
  450. ┌─
  451. │  5.0  ■  Credits and Thanks
  452. └─────────────────────────────────────────────────────────────────────────────
  453.  
  454.    Thanks to my beta testers for helping me test my progs and for their
  455.    numerous suggestions, helpful criticism and for the multitude of
  456.    bug reports.
  457.  
  458.    Thanks to Andrew Pappas, Michael Devonport and Peter Burnett for their
  459.    help with the Multi-Line BBS and Mailer support.
  460.  
  461.    Thanks to Peter Burnett for help with the InterMail support and with
  462.    supplying various bits of source code.
  463.  
  464.    Many thanks to Simon Cansick for help with the FrontDoor v2.20ml support.
  465.  
  466.    Also thanks must go out to all the people who have sent suggestions
  467.    to me (Please keep it up), no names since you know who you are (actually
  468.    the list is too large to be included here)
  469.  
  470.  
  471.  Beta Testers
  472.  ============
  473.  
  474.    Steven Holme         The Fonty Towers BBS      +44-115-952-7443
  475.                         FidoNet    2:2503/216     +44-115-955-4440
  476.                                    2:2503/226
  477.                         RANet     73:7444/22
  478.  
  479.    Peter Burnett        Neverland eXpress         +44-1424-853361
  480.                         FidoNet    2:441/80
  481.                         RANet     73:7441/206
  482.  
  483.    Michael Devonport    Midnite Madness BBS       +44-181-287-5901
  484.                         FidoNet    2:254/301
  485.                         RANet     73:7441/15
  486.  
  487.    Simon Cansick        Guru-Ten BBS              +44-1535-691734
  488.                         FidoNet    2:250/364      +44-1535-691735
  489.                                    2:250/365
  490.                         RANet     73:7448/13
  491.  
  492.  
  493. ┌─
  494. │                           End of File ONTODAY.DOC
  495. └─────────────────────────────────────────────────────────────────────────────
  496.  
  497.